Skip to content

docs(cloud): Rewrite CLI reference introduction and rename category to CLI#597

Open
developerjamiu wants to merge 1 commit into
mainfrom
docs/cloud-cli-reference-intro
Open

docs(cloud): Rewrite CLI reference introduction and rename category to CLI#597
developerjamiu wants to merge 1 commit into
mainfrom
docs/cloud-cli-reference-intro

Conversation

@developerjamiu

Copy link
Copy Markdown
Contributor

PR 10 of the Cloud IA rollout (#568). Scaffolding only; substantive command-by-command writing is PR 11 + PR 12.

Summary

  • Rewrite `cloud_docs/reference/cli/introduction/introduction.md` from a tutorial-shaped walkthrough (install → login → launch → deploy → show) into a meta-template-shaped reference landing. Sections: opener, install + authenticate (link-only), command syntax shape, global options summary, environment variables summary, where each topic area's concept page lives, and how the reference is organized (hand-written intros + auto-generated subcommand listings). Tutorial content has its own home now ("Deploy your first app") so the intro no longer duplicates it.
  • Rename the CLI category label from "CLI reference" to "CLI" in `category.json`. URL path `/cloud/reference/cli/*` and sidebar position (9 under Reference) are unchanged.

The original plan considered promoting CLI reference to a top-level sidebar section per IA §4, but the user opted to keep it nested under Reference for now. The label rename is the visible change.

Test plan

  • `npm run build` passes in CI.
  • Open the new `/cloud/reference/cli/introduction/introduction` page and read top to bottom; every link resolves.
  • Sidebar shows Reference → CLI (with the renamed label) and the existing position.
  • Inbound links to `/cloud/reference/cli/*` from other pages still resolve (no URL changes).

@developerjamiu developerjamiu self-assigned this Jun 11, 2026
@developerjamiu developerjamiu added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 11, 2026
@@ -1,49 +1,53 @@
---
title: Introduction
description: How to find any scloud command, read its documentation, and use the global options and environment variables that apply across every command.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this description could be something else apart from how to

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants